Skip to main content

UserFeed

Interfaces

UserFeedProps

Properties

FeedObjectProps?

optional FeedObjectProps: FeedObjectProps

Props to spread to single feed object

Default
empty object
Source

UserFeed/UserFeed.tsx:72

FeedProps?

optional FeedProps: Omit<FeedProps, "endpoint" | "ItemComponent" | "widgets" | "itemPropsGenerator" | "itemIdGenerator" | "ItemSkeleton" | "ItemSkeletonProps" | "FeedSidebarProps">

Props to spread to feed component

Default
{}
Source

UserFeed/UserFeed.tsx:84

FeedSidebarProps?

optional FeedSidebarProps: StickyBoxProps

Props to spread to single feed object

Default
{top: 0, bottomBoundary: `#${id}`}
Source

UserFeed/UserFeed.tsx:78

className?

optional className: string

Overrides or extends the styles applied to the component.

Default
null
Source

UserFeed/UserFeed.tsx:48

id?

optional id: string

Id of the feed object

Default
'user_feed'
Source

UserFeed/UserFeed.tsx:42

user?

optional user: SCUserType

User Object

Default
null
Source

UserFeed/UserFeed.tsx:60

userId?

optional userId: number

Id of the user for filter the feed

Default
null
Source

UserFeed/UserFeed.tsx:54

widgets?

optional widgets: SCFeedWidgetType[]

Widgets to be rendered into the feed

Default
[UserFollowedCategoriesWidget, UserFollowedUsersWidget]
Source

UserFeed/UserFeed.tsx:66

Functions

UserFeed()

UserFeed(inProps): JSX.Element

API documentation for the Community-JS User Feed Template. Learn about the available props and the CSS API.

This component renders a specific user's feed template. Take a look at our demo component here

Import

import {UserFeed} from '@selfcommunity/react-templates';

Component Name

The name SCUserFeedTemplate can be used when providing style overrides in the theme.

CSS

Rule NameGlobal classDescription
root.SCUserFeedTemplate-rootStyles applied to the root element.

Parameters

ParameterTypeDescription
inPropsUserFeedProps

Returns

JSX.Element

Source

UserFeed/UserFeed.tsx:140


UserFeedSkeleton()

UserFeedSkeleton(): JSX.Element

API documentation for the Community-JS User Feed Skeleton Template. Learn about the available props and the CSS API.

Import

import {UserFeedSkeleton} from '@selfcommunity/react-templates';

Component Name

The name SCUserFeedTemplate-skeleton-root can be used when providing style overrides in the theme.

CSS

Rule NameGlobal classDescription
root.SCUserFeedTemplate-skeleton-rootStyles applied to the root element.

Returns

JSX.Element

Source

UserFeed/Skeleton.tsx:35